package com.itany.cloud.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2 // 启用Swagger2配置
public class SwaggerConfig {

    @Bean
    public Docket createRestfulApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                // 指定文档的基本信息
                .apiInfo(apiInfo())
                .select()
                // 指定需要扫描的Swagger注解所在的包名
                .apis(RequestHandlerSelectors.basePackage("com.itany.cloud.controller"))
                // 配置级联扫描
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 创建API接口文档的基本信息
     * 这些信息会在对应的接口文档中展现出来
     * @return
     */
    public ApiInfo apiInfo(){
        // 在ApiInfo对象中,所有的属性均为常量,无法被修改
        // 因此,需要使用ApiInfoBuilder进行构建
        // 在ApiInfoBuilder中,可以选择性的构建指定的属性信息
        // 最终返回ApiInfo对象
        return new ApiInfoBuilder()
                // 标题
                .title("用户功能PC端接口文档")
                // 详细的描述信息
                .description("使用Swagger2构建的基于Restful的用户功能相关PC端接口文档")
                // 联系人信息:姓名、地址、邮箱
                .contact(new Contact("admin","https://www.baidu.com/","123456@qq.com"))
                // 版本号
                .version("1.0-SNAPSHOT")
                .build();
    }

}
